vfsStream: vfsStreamContent Interface Reference

Inheritance diagram for vfsStreamContent:

Public Member Functions
	getName ()
	rename ($newName)
	appliesTo ($name)
	getType ()
	size ()
	setFilemtime ($filemtime)
	lastModified ($filemtime)
	filemtime ()
	at (vfsStreamContainer $container)
	chmod ($permissions)
	getPermissions ()
	isReadable ($user, $group)
	isWritable ($user, $group)
	isExecutable ($user, $group)
	chown ($user)
	isOwnedByUser ($user)
	getUser ()
	chgrp ($group)
	isOwnedByGroup ($group)
	getGroup ()
Data Fields
const	TYPE_FILE = 0100000
const	TYPE_DIR = 0040000

Member Function Documentation

appliesTo ( $ name )

checks whether the container can be applied to given name

Parameters:

string $name

Returns:: bool

Implemented in vfsStreamAbstractContent, and vfsStreamFile.

at ( vfsStreamContainer $ container )

adds content to given container

Parameters:

vfsStreamContainer $container

Returns:: vfsStreamContent

Implemented in vfsStreamAbstractContent.

chgrp ( $ group )

change owner group of file to given group

Parameters:

int $group

Returns:: vfsStreamContent

Implemented in vfsStreamAbstractContent.

chmod ( $ permissions )

change file mode to given permissions

Parameters:

int $permissions

Returns:: vfsStreamContent

Implemented in vfsStreamAbstractContent.

chown ( $ user )

change owner of file to given user

Parameters:

int $user

Returns:: vfsStreamContent

Implemented in vfsStreamAbstractContent.

filemtime ( )

returns the last modification time of the stream content

Returns:: int

Implemented in vfsStreamAbstractContent.

getGroup ( )

returns owner group of file

Returns:: int

Implemented in vfsStreamAbstractContent.

getName ( )

stream content type: symbolic link

See also:: getType(); returns the file name of the content

Returns:: string

Implemented in vfsStreamAbstractContent.

getPermissions ( )

returns permissions

Returns:: int

Implemented in vfsStreamAbstractContent.

getType ( )

returns the type of the container

Returns:: int

Implemented in vfsStreamAbstractContent.

getUser ( )

returns owner of file

Returns:: int

Implemented in vfsStreamAbstractContent.

isExecutable	(	$	user,
		$	group
	)

checks whether content is executable

Parameters:

int	$user	id of user to check for
int	$group	id of group to check for

Returns:: bool

Implemented in vfsStreamAbstractContent.

isOwnedByGroup ( $ group )

checks whether file is owned by group

Parameters:

int $group

Returns:: bool

Implemented in vfsStreamAbstractContent.

isOwnedByUser ( $ user )

checks whether file is owned by given user

Parameters:

int $user

Returns:: bool

Implemented in vfsStreamAbstractContent.

isReadable	(	$	user,
		$	group
	)

checks whether content is readable

Parameters:

int	$user	id of user to check for
int	$group	id of group to check for

Returns:: bool

Implemented in vfsStreamAbstractContent.

isWritable	(	$	user,
		$	group
	)

checks whether content is writable

Parameters:

int	$user	id of user to check for
int	$group	id of group to check for

Returns:: bool

Implemented in vfsStreamAbstractContent.

lastModified ( $ filemtime )

sets the last modification time of the stream content

Parameters:

int $filemtime

Returns:: vfsStreamContent

Implemented in vfsStreamAbstractContent.

rename ( $ newName )

renames the content

Parameters:

string $newName

Implemented in vfsStreamAbstractContent, and vfsStreamDirectory.

setFilemtime ( $ filemtime )

alias for lastModified()

Parameters:

int $filemtime

Returns:: vfsStreamContent

See also:: lastModified()

Implemented in vfsStreamAbstractContent.

size ( )

returns size of content

Returns:: int

Implemented in vfsStreamDirectory, and vfsStreamFile.

Field Documentation

const TYPE_DIR = 0040000

stream content type: directory

See also:: getType()

const TYPE_FILE = 0100000

stream content type: file

See also:: getType()

The documentation for this interface was generated from the following file:

/Applications/XAMPP/xamppfiles/lib/php/pear/vfsStream/vfsStreamContent.php